<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>src/lib/collections/files.coffee</title>
    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="icon" href="../assets/favicon.ico">
    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
                <h1><img src="../assets/css/logo.png" title="" width="117" height="52"></h1>
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: </em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
                    <h2 class="off-left">APIs</h2>
                    <div id="api-tabview" class="tabview">
                        <ul class="tabs">
                            <li><a href="#api-classes">Classes</a></li>
                            <li><a href="#api-modules">Modules</a></li>
                        </ul>
                
                        <div id="api-tabview-filter">
                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
                        </div>
                
                        <div id="api-tabview-panel">
                            <ul id="api-classes" class="apis classes">
                                <li><a href="../classes/BasePlugin.html">BasePlugin</a></li>
                                <li><a href="../classes/Collection.html">Collection</a></li>
                                <li><a href="../classes/Docpad.html">Docpad</a></li>
                                <li><a href="../classes/docpadUtil.html">docpadUtil</a></li>
                                <li><a href="../classes/DocumentModel.html">DocumentModel</a></li>
                                <li><a href="../classes/ElementsCollection.html">ElementsCollection</a></li>
                                <li><a href="../classes/Events.html">Events</a></li>
                                <li><a href="../classes/FileModel.html">FileModel</a></li>
                                <li><a href="../classes/FilesCollection.html">FilesCollection</a></li>
                                <li><a href="../classes/MetaCollection.html">MetaCollection</a></li>
                                <li><a href="../classes/Model.html">Model</a></li>
                                <li><a href="../classes/PluginLoader.html">PluginLoader</a></li>
                                <li><a href="../classes/PluginTester.html">PluginTester</a></li>
                                <li><a href="../classes/QueryCollection.html">QueryCollection</a></li>
                                <li><a href="../classes/ScriptCollection.html">ScriptCollection</a></li>
                                <li><a href="../classes/ServerTester.html">ServerTester</a></li>
                                <li><a href="../classes/StylesCollection.html">StylesCollection</a></li>
                            </ul>
                
                
                            <ul id="api-modules" class="apis modules">
                            </ul>
                        </div>
                    </div>
                </div>
            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
                    Show:
                    <label for="api-show-inherited">
                        <input type="checkbox" id="api-show-inherited" checked>
                        Inherited
                    </label>
            
                    <label for="api-show-protected">
                        <input type="checkbox" id="api-show-protected">
                        Protected
                    </label>
            
                    <label for="api-show-private">
                        <input type="checkbox" id="api-show-private">
                        Private
                    </label>
                    <label for="api-show-deprecated">
                        <input type="checkbox" id="api-show-deprecated">
                        Deprecated
                    </label>
            
                </div>
            
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
<h1 class="file-heading">File: src/lib/collections/files.coffee</h1>

<div class="file">
    <pre class="code prettyprint linenums">
# =====================================
# Requires

# Standard Library
pathUtil = require(&#x27;path&#x27;)

# Local
{QueryCollection,Model} = require(&#x27;../base&#x27;)
FileModel = require(&#x27;../models/file&#x27;)


# =====================================
# Classes

###*
# The DocPad files and documents query collection class
# Extends the DocPad QueryCollection class
# https://github.com/docpad/docpad/blob/master/src/lib/base.coffee#L91
# Used as the query collection class for DocPad files and documents.
# This differs from standard collections in that it provides backbone.js,
# noSQL style methods for querying the file system. In DocPad this
# is the various files that make up a web project. Typically this is the documents,
# css, script and image files.
#
# Most often a developer will use this class to find (and possibly sort) documents,
# such as blog posts, by some criteria.
# 	posts: -&gt;
# 		@getCollection(&#x27;documents&#x27;).findAllLive({relativeOutDirPath: &#x27;posts&#x27;},[{date:-1}])
# @class FilesCollection
# @constructor
# @extends QueryCollection
###
class FilesCollection extends QueryCollection

	###*
	# Base Model for all items in this collection
	# @private
	# @property {Object} model
	###
	model: FileModel

	###*
	# Base Collection for all child collections
	# @private
	# @property {Object} collection
	###
	collection: FilesCollection

	###*
	# Initialize the collection
	# @private
	# @method initialize
	# @param {Object} attrs
	# @param {Object} [opts={}]
	###
	initialize: (attrs,opts={}) -&gt;
		@options ?= {}
		@options.name ?= opts.name or null
		super

	###*
	# Fuzzy find one
	# Useful for layout searching
	# @method fuzzyFindOne
	# @param {Object} data
	# @param {Object} sorting
	# @param {Object} paging
	# @return {Object} the file, if found
	###
	fuzzyFindOne: (data,sorting,paging) -&gt;
		# Prepare
		escapedData = data?.replace(/[\/]/g, pathUtil.sep)
		queries = [
			{relativePath: escapedData}
			{relativeBase: escapedData}
			{url: data}
			{relativePath: $startsWith: escapedData}
			{fullPath: $startsWith: escapedData}
			{url: $startsWith: data}
		]

		# Try the queries
		for query in queries
			file = @findOne(query, sorting, paging)
			return file  if file

		# Didn&#x27;t find a file
		return null


# =====================================
# Export
module.exports = FilesCollection

    </pre>
</div>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
